JAMS REST API Web Service
All Operations Resource Group
Operations
DeleteAgent_DeleteAgent
Deletes an Agent object.
GetAgent_GetAgent
Gets a list of all agents
GetAgent_GetAgentByID
Get the Agent with the specified agentID.
GetAgent_GetAgentByName
Get the Agent with the specified agentName.
PostAgent_PostAgent
Creates a new Agent object.
PutAgent_PutAgent
Updates an existing Agent object or creates a new definition if it doesn't exist.
GetAppMenu_GetAppMenu
Get all AppMenuItems.
GetAuthentication_GetAuthentication
Provides information about the authenticated user
PostAuthentication_Login
Login to the web server
DeleteBatchQueue_DeleteBatchQueue
Delete the batch queue definition by name.
GetBatchQueue_GetBatchQueue
Gets all batch queue definitions
GetBatchQueue_GetBatchQueueByID
Gets a batch queue definition by ID
GetBatchQueue_GetBatchQueueByName
Gets a batch queue definition by name
PostBatchQueue_PostBatchQueue
Adds a new batch queue definition
PutBatchQueue_PutBatchQueue
Updates an existing batch queue
PostBatchQueue_StartBatchQueue
Starts a batch queue
PostBatchQueue_StopBatchQueue
Stops a batch queue
DeleteCfg_DeleteCfg
Deletes a Configuration object.
GetCfg_GetCfg
Gets a list of all configurations
GetCfg_GetCfgByName
Get the Configuration with the specified configName.
PostCfg_PostCfg
Creates a new Configuration object.
PutCfg_PutConfig
Updates an existing Cfg object or creates a new definition if it doesn't exist.
GetDate_GetEvaluateDate
Evaluate a natural language date and return the date that it identifies.
PutDate_PutDate
Adds a date to an existing DateType or creates a new DateType if it doesn't exist.
DeleteDateType_DeleteDateType
Deletes a DateType object.
GetDateType_GetDateType
Gets a collection of all DateTypes
GetDateType_GetDateTypeByID
Get the DateType with the specified ID.
GetDateType_GetDateTypeByName
Get the DateType with the specified name.
PostDateType_PostDateType
Creates a new DateType object.
PutDateType_PutDateType
Updates an existing DateType object or creates a new definition if it doesn't exist.
GetEntry_Download
Gets log file as download or preview of first 512 kB.
GetEntry_GetEntry
Gets entry information for all entries in the current schedule.
GetEntry_GetEntryByID
Gets Entry information with the specified ID
GetEntry_GetEntryParameter
Gets parameter value for a given entry.
GetEntry_GetEntryParameters
Gets parameter list for a given entry.
PutEntry_PutEntryCancel
Cancels a JAMS entry.
PutEntry_PutEntryParameter
Sets parameter value for a given entry.
PutEntry_PutEntryReschedule
Reschedules a JAMS entry.
PutEntry_PutEntryRestart
Restarts a JAMS entry.
PutEntry_PutEntryStatus
Sets the status message for an entry.
PutEntry_PutHoldEntry
Holds an Entry with the specified ID, with the specified HoldEntry Audit Comment.
PutEntry_PutReleaseEntry
Releases a CurJob with the specified ID to Run Again, with specified ReleaseEntry Audit Comment
GetEntryAuditTrail_GetEntryAuditTrails
Gets Entry Audit Trail.
DeleteFolder_DeleteFolder
Deletes a folder definition
GetFolder_GetFolderByID
Get full folder definition by ID
GetFolder_GetFolderByName
Get full folder definition by name.
GetFolder_GetFoldersByParentID
Gets all child folder definitions of selected folder by ID
GetFolder_GetFoldersByParentName
Gets all child folder definitions of selected folder by name
GetFolder_GetSubFoldersOfRootFolder
Gets all child folder definitions of the root folder
PostFolder_PostFolder
Adds a new folder definition
PutFolder_PutFolder
Updates an existing folder definition
GetHelp_GetHelp
GetHistory_GetHistory
Gets job execution history.
GetHistory_GetHistoryOdata
Gets job execution history using OData filters.
GetHistory_GetJobLog
Gets log file as download or preview of first 512 kB.
GetHistory_GetSetupLog
Gets log file as download or preview of first 512 kB.
DeleteJob_DeleteJob
Deletes a Job by name.
GetJob_GetJobByID
Get the Job with the specified ID.
GetJob_GetJobByName
Get the Job with the specified name.
GetJob_GetJobs
Gets a list of all jobs
GetJob_GetJobsByFolder
Gets Jobs in the Folder with the specified name
GetJob_GetJobsByFolderID
Gets all jobs in the Folder with the specified ID
PostJob_PostJob
Creates a new Job object.
PutJob_PutJob
Updates an existing Job object or creates new definition if it doesn't exist.
GetJsSettings_GetJsSettings
DeleteResource_DeleteResource
Delete the resource definition by name
GetResource_GetResource
Gets all resources
GetResource_GetResourceByID
Gets a resource by ID
GetResource_GetResourceByName
Gets a resource by name
PostResource_PostResource
Add a new resource definition
PutResource_PutResource
Updates an existing resource
PostResource_SetQuantityAvailable
Change the value of quantity available on a resource
DeleteSetup_DeleteSetup
Deletes a Setup definition.
GetSetup_GetSetup
Gets a collection of all setups
GetSetup_GetSetupByID
Get the Setup with the specified ID.
GetSetup_GetSetupByName
Get the Setup with the specified setupName.
GetSetup_GetSetupsByFolderID
Gets all Setups in the folder with the specified ID
PostSetup_PostSetup
Creates a new Setup definition
PutSetup_PutSetup
Updates an existing Setup definition or creates a new definition if it doesn't exist.
GetSubmit_GetSubmitByID
Get the submit info for a Job with the specified ID
GetSubmit_GetSubmitByName
Get the submit information for a Job or Setup with the specified name.
GetSubmit_GetSubmitSetup
Get the submit info for a Setup with the specified ID
PostSubmit_PostSubmit
Submit the job specified in the SubmitInfo object. Usually, you create the SubmitInfo object by calling GetSubmit which returns a SubmitInfo. You can then modify values in the SubmitInfo before calling PutSubmit.
GetSubmitMenu_GetNestedMenu
Gets the full populated menu. This is starts from the Folders in the root.
GetSubmitMenu_GetSubmitMenu
Gets the default root level menu. This is created from the Folders in the root.
GetSubmitMenu_GetSubmitMenuByID
Gets the entries in a branch of a submit menu. Use GetSubmitMenuByName to get the top level menu and use this to expand branches when they are selected.
GetSubmitMenu_GetSubmitMenuByName
Gets a submit menu.
GetTenant_GetTenant
GetTheme_GetTheme
DeleteTrigger_DeleteTrigger
Deletes a trigger definition
PostTrigger_DisableTrigger
Disables a trigger by name
PostTrigger_EnableTrigger
Enables a trigger by name
GetTrigger_GetTriggerByName
Gets a trigger definition by name
GetTrigger_GetTriggersByFolderID
Gets all trigger definitions by parent folder ID
PostTrigger_PostTrigger
Adds a new trigger definition to a JAMS Server
PutTrigger_PutTrigger
Updates and existing trigger definition
PostTrigger_ResetTrigger
Resets a trigger
DeleteUserSecurity_DeleteUser
Deletes a UserSecurity object.
GetUserSecurity_GetUser
Gets a collection of all users
GetUserSecurity_GetUserByID
Get the User with the specified ID.
GetUserSecurity_GetUserByName
Get the UserSecurity with the specified name.
PostUserSecurity_PostUser
Creates a new UserSecurity object.
PutUserSecurity_PutUser
Updates an existing UserSecurity object or creates new definition if it doesn't exist.
PostVariable_ChangeVariableValue
Changes the value of a variable identified by name
DeleteVariable_DeleteVariable
Deletes a variable definition
GetVariable_GetVariable
Gets a list of variables that match the queryString
GetVariable_GetVariableByID
Get the Variable with the specified ID.
GetVariable_GetVariablesByFolderID
Gets a list of variables under the specified folder definition by ID
PostVariable_PostVariable
Creates a new variable definition
PutVariable_PutVariable
Update the Variable object.
See Also
JAMS REST API Web Service

 

 


© 2017 All Rights Reserved.

Send comments on this topic.